package edu.mtu.citizenscience.mushroommapper.json.fieldguide;

/**
 * @author Corbin Uselton <corbinu@cwuselto@mtu.edu>
 * @copyright (c) 2012 MichiganTech <http://www.mtu.edu>
 * @since 1.0
 * 
 * Guide mushroom object used by Jackson JSON to load in
 * the field guide mushrooms in field_guide.json
 */
public class GuideMushroom {
	// holds the mushroom family name
	private String family;
	// holds the mushroom genus name
	private String genus;
	// holds the mushroom species name
	private String species;
	// holds the mushroom common name
	private String name;
	// holds the mushroom description
	private String description;
	// holds the mushroom image path
	private String image;
		
	/**
	 * Get the mushroom family name
	 * 
	 * @param   void
	 * @return	String - the mushroom family name
	 */
	public String getFamily() 
	{
		return family;
	}

	/**
	 * Set the mushroom family name
	 * 
	 * @param   image - String - the mushroom family name
	 * @return	void
	 */
	public void setFamily(String family) 
	{
		this.family = family;
	}

	/**
	 * Get the mushroom genus name
	 * 
	 * @param   void
	 * @return	String - the mushroom genus name
	 */
	public String getGenus() 
	{
		return genus;
	}

	/**
	 * Set the mushroom genus name
	 * 
	 * @param   image - String - the mushroom genus name
	 * @return	void
	 */
	public void setGenus(String genus) 
	{
		this.genus = genus;
	}
	
	/**
	 * Get the mushroom species name
	 * 
	 * @param   void
	 * @return	String - the mushroom species name
	 */
	public String getSpecies() 
	{
		return species;
	}

	/**
	 * Set the mushroom species name
	 * 
	 * @param   image - String - the mushroom species name
	 * @return	void
	 */
	public void setSpecies(String species) 
	{
		this.species = species;
	}

	/**
	 * Get the mushroom common name
	 * 
	 * @param   void
	 * @return	String - the mushroom common name
	 */
	public String getName() 
	{
		return name;
	}
	
	/**
	 * Set the mushroom common name
	 * 
	 * @param   image - String - the mushroom common name
	 * @return	void
	 */
	public void setName(String name) 
	{
		this.name = name;
	}

	/**
	 * Get the mushroom description
	 * 
	 * @param   void
	 * @return	String - the mushroom description
	 */
	public String getDescription() 
	{
		return description;
	}

	/**
	 * Set the mushroom description
	 * 
	 * @param   image - String - the mushroom description
	 * @return	void
	 */
	public void setDescription(String description) 
	{
		this.description = description;
	}

	/**
	 * Get the mushroom image path
	 * 
	 * @param   void
	 * @return	String - the mushroom image path
	 */
	public String getImage() 
	{
		return image;
	}
	
	/**
	 * Set the mushroom image path
	 * 
	 * @param   image - String - the mushroom image path
	 * @return	void
	 */
	public void setImage(String image) 
	{
		this.image = image;
	}
}
